[jsonrpc] fix estimated rewards during safe mode #20182
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
3 Skipped Deployments
|
emmazzz
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
emmazzz
requested review from
patrickkuo,
bmwill,
longbowlu,
lxfind and
sblackshear
emmazzz
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
lxfind
reviewed
Nov 5, 2024
| return rates; | ||
| } | ||
|
|
||
| let min_epoch = *rates.iter().map(|(e, _)| e).min().unwrap(); |
There was a problem hiding this comment.
It's probably easier to sort it first before processing.
But otherwise this code looks good to me.
There was a problem hiding this comment.
I'm not sure if sorting it first will make things easier because then we'd have to keep track of the index we are at separately and insert the missing entry, etc. The logic may get messier. Unless I'm missing something.
There was a problem hiding this comment.
You just iterate the sorted vector. No need for min/max/find calls.
There was a problem hiding this comment.
This is the alternative implementation I came up with:
fn backfill_rates(
mut rates: Vec<(EpochId, PoolTokenExchangeRate)>,
) -> Vec<(EpochId, PoolTokenExchangeRate)> {
if rates.is_empty() {
return rates;
}
rates.sort_by(|(a, _), (b, _)| a.cmp(b));
let mut filled_rates = vec![];
let mut next_epoch_to_fill = rates[0].0;
let mut prev_rate = rates[0].1.clone();
for (epoch, rate) in rates {
// Fill in all the gaps between the previous entry and the current entry.
while epoch > next_epoch_to_fill {
filled_rates.push((next_epoch_to_fill, prev_rate.clone()));
next_epoch_to_fill += 1;
}
filled_rates.push((next_epoch_to_fill, rate.clone()));
next_epoch_to_fill += 1;
prev_rate = rate;
}
filled_rates.reverse();
filled_rates
}I think this is harder to understand and get right. It took me quite a few tries to get the code right, with off-by-one errors etc
lxfind
approved these changes
Nov 5, 2024
sblackshear
reviewed
Nov 5, 2024
| @@ -431,7 +432,8 @@ async fn exchange_rates( | |||
| }) | |||
| .collect::<Result<Vec<_>, _>>()?; | |||
|
|
|||
| rates.sort_by(|(a, _), (b, _)| a.cmp(b).reverse()); | |||
There was a problem hiding this comment.
Is line 466/467 attempting to do the equivalent of this?
There was a problem hiding this comment.
The loop in backfill_rates does backfilling + sorting in ascending order by epoch number. And line 484 reverses the vector so it becomes sorted in descending order.
emmazzz
added a commit
that referenced
this pull request
Nov 6, 2024
## Description Currently if the exchange rate for an epoch is not found, we would assign it the default exchange rate while we should've used the exchange rate from the previous existing epoch instead. This PR fixes that. ## Test plan Added some unit tests. --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [x] JSON-RPC: fixed reward estimation in `getStakes` API so that we don't overestimate stake rewards of stakes activated during safe mode epochs. - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: - [ ] REST API:
emmazzz
added a commit
that referenced
this pull request
Nov 6, 2024
## Description Currently if the exchange rate for an epoch is not found, we would assign it the default exchange rate while we should've used the exchange rate from the previous existing epoch instead. This PR fixes that. ## Test plan Added some unit tests. --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [x] JSON-RPC: fixed reward estimation in `getStakes` API so that we don't overestimate stake rewards of stakes activated during safe mode epochs. - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: - [ ] REST API:
emmazzz
added a commit
that referenced
this pull request
Nov 6, 2024
## Description Currently if the exchange rate for an epoch is not found, we would assign it the default exchange rate while we should've used the exchange rate from the previous existing epoch instead. This PR fixes that. ## Test plan Added some unit tests. --- ## Release notes Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required. For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [x] JSON-RPC: fixed reward estimation in `getStakes` API so that we don't overestimate stake rewards of stakes activated during safe mode epochs. - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: - [ ] REST API:
longbowlu
reviewed
Nov 6, 2024
| @@ -451,6 +453,38 @@ pub struct ValidatorExchangeRates { | |||
| pub rates: Vec<(EpochId, PoolTokenExchangeRate)>, | |||
| } | |||
|
|
|||
| /// Backfill missing rates for some epochs due to safe mode. If a rate is missing for epoch e, | |||
| /// we will use the rate for epoch e-1 to fill it. | |||
There was a problem hiding this comment.
"we will use the value from the nearest prior epoch"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Currently if the exchange rate for an epoch is not found, we would assign it the default exchange rate while we should've used the exchange rate from the previous existing epoch instead. This PR fixes that.
Test plan
Added some unit tests.
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.
getStakesAPI so that we don't overestimate stake rewards of stakes activated during safe mode epochs.